
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>stratified_plume_model.Model.save_sim &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="stratified_plume_model.Model.save_txt" href="stratified_plume_model.Model.save_txt.html" />
    <link rel="prev" title="stratified_plume_model.Model.plot_state_space" href="stratified_plume_model.Model.plot_state_space.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="stratified-plume-model-model-save-sim">
<h1>stratified_plume_model.Model.save_sim<a class="headerlink" href="#stratified-plume-model-model-save-sim" title="Permalink to this headline">¶</a></h1>
<dl class="method">
<dt id="stratified_plume_model.Model.save_sim">
<code class="sig-prename descclassname">Model.</code><code class="sig-name descname">save_sim</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">fname</em>, <em class="sig-param">profile_path</em>, <em class="sig-param">profile_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/stratified_plume_model.html#Model.save_sim"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#stratified_plume_model.Model.save_sim" title="Permalink to this definition">¶</a></dt>
<dd><p>Save the current simulation results</p>
<p>Save the current simulation results and the model parameters so that
all information needed to rebuild the class object is stored in a
file.  The output data are stored in netCDF4-classic format.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>fname</strong><span class="classifier">str</span></dt><dd><p>File name of the file to write</p>
</dd>
<dt><strong>profile_path</strong><span class="classifier">str</span></dt><dd><p>String stating the file path to the ambient profile data relative
to the directory where <cite>fname</cite> will be saved.</p>
</dd>
<dt><strong>profile_info</strong><span class="classifier">str</span></dt><dd><p>Single line of text describing the ambient profile data.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="../disp_phases/dispersed_phases.save_particle_to_nc_file.html#dispersed_phases.save_particle_to_nc_file" title="dispersed_phases.save_particle_to_nc_file"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dispersed_phases.save_particle_to_nc_file</span></code></a></dt><dd></dd>
</dl>
</div>
<p class="rubric">Notes</p>
<p>It does not make sense to store the ambient data together with every
simulation output file.  On the other hand, the simulation results
may be meaningless without the context of the ambient data.  The
parameter <cite>profile_path</cite> provides a means to automatically load the
ambient data assuming the profile data are kept in the same place
relative to the output file.  Since this cannot be guaranteed, the
<cite>profile_info</cite> variable provides additional descriptive information
so that the ambient data can be identified if they have been moved.</p>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/spm.html">Overview of Stratified Plume Model Module</a><ul>
  <li><a href="stratified_plume_model.Model.html">stratified_plume_model.Model</a><ul>
      <li>Previous: <a href="stratified_plume_model.Model.plot_state_space.html" title="previous chapter">stratified_plume_model.Model.plot_state_space</a></li>
      <li>Next: <a href="stratified_plume_model.Model.save_txt.html" title="next chapter">stratified_plume_model.Model.save_txt</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/spm/stratified_plume_model.Model.save_sim.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>